The Dreamweaver JavaScript API > Selection functions > site.getCheckOutUserForFile()

 

site.getCheckOutUserForFile()

Availability

Dreamweaver 3.0

Description

Gets the login and check out name of the user that has the specified file checked out.

Arguments

fileName

fileName is the path to the file being inquired about, expressed as afile:// URL.

Returns

A string containing the login and check out name of the user that has the file checked out, or an empty string if the file is not checked out.

Enabler

None.

Example

A call to site.getCheckOutUserForFile("file://C:/sites/avocado8/index.html") might return "lori (loriLaptop)". If no check out name is specified, only the login is returned (for example, "lori").